Spring Boot——实现定时任务的两种方式

一、@Scheduled

使用 @Scheduled 非常容易，直接创建一个 Spring Boot 项目，并且添加 web 依赖 spring-boot-starter-web，项目创建成功后，在启动类添加 @EnableScheduling 注解，开启定时任务：

@SpringBootApplication
@EnableScheduling
public class ScheduleApplication {
 
    public static void main(String[] args) {
        SpringApplication.run(ScheduleApplication.class, args);
    }
 
}

接下来配置定时任务，新建一个service测试，详细含义已经写在注释里：

@Service
public class HelloService {
    //使用 @Scheduled 注解开启一个定时任务，所有时间单位都是毫秒。
    @Scheduled(fixedDelay = 2000)//前面的任务结束时间和后面任务的开始时间之间间隔2s
    public void fixedDelay(){
  //     System.out.println("fixedDelay>>"+new Date());//每隔2s打印一次
    }
 
    @Scheduled(fixedRate = 2000)//两次定时任务"开始"的时间间隔为2s (新的任务执行时，不管旧的任务有没有结束)
    public void fixedRate(){
  //      System.out.println("fixedRate>>"+new Date());
    }
 
    @Scheduled(initialDelay = 2000,fixedDelay = 2000)// 表示首次任务启动的延迟时间。
    public void initialDelay(){
        System.out.println("initialDelay>>"+new Date());
    }
 
}

上面这是一个基本用法，除了这几个基本属性之外，@Scheduled 注解也支持 cron 表达式，使用 cron 表达式，可以非常丰富的描述定时任务的时间。cron 表达式格式如下：

[秒] [分] [小时] [日] [月] [周] [年]

具体取值如下，（**月份中的日期和星期可能会起冲突，因此在配置时这两个得有一个是 ?**）

通配符含义：

? 表示不指定值，即不关心某个字段的取值时使用。需要注意的是，月份中的日期和星期可能会起冲突，因此在配置时这两个得有一个是 ?
*表示所有值，例如:在秒的字段上设置 *,表示每一秒都会触发
, 用来分开多个值，例如在周字段上设置 “MON,WED,FRI” 表示周一，周三和周五触发
-表示区间，例如在秒上设置 “10-12”,表示 10,11,12秒都会触发
/用于递增触发，如在秒上面设置”5/15” 表示从5秒开始，每增15秒触发(5,20,35,50)
#序号(表示每月的第几个周几)，例如在周字段上设置”6#3”表示在每月的第三个周六，(用在母亲节和父亲节再合适不过了)
周字段的设置，若使用英文字母是不区分大小写的，即 MON 与mon相同
L 表示最后的意思。在日字段设置上，表示当月的最后一天(依据当前月份，如果是二月还会自动判断是否是润年), 在周字段上表示星期六，相当于”7”或”SAT”（注意周日算是第一天）。如果在”L”前加上数字，则表示该数据的最后一个。例如在周字段上设置”6L”这样的格式,则表示”本月最后一个星期五”
W 表示离指定日期的最近工作日(周一至周五)，例如在日字段上设置”15W”，表示离每月15号最近的那个工作日触发。如果15号正好是周六，则找最近的周五(14号)触发, 如果15号是周未，则找最近的下周一(16号)触发，如果15号正好在工作日(周一至周五)，则就在该天触发。如果指定格式为 “1W”,它则表示每月1号往后最近的工作日触发。如果1号正是周六，则将在3号下周一触发。(注，”W”前只能设置具体的数字,不允许区间”-“)
L 和 W 可以一组合使用。如果在日字段上设置”LW”,则表示在本月的最后一个工作日触发(一般指发工资 )

例如，在 @Scheduled 注解中来一个简单的 cron 表达式，在11时内每隔5秒触发一次，如下：

@Scheduled(cron ="0/5 * 11 * * ?") //表示在11时内每个5秒发送一次
   public void cron(){
       System.out.println(new Date());
   }

上面介绍的是使用 @Scheduled 注解的方式来实现定时任务，接下来我们再来看看如何使用 Quartz 实现定时任务。

二、Quartz

一般在项目中，除非定时任务涉及到的业务实在是太简单，使用 @Scheduled 注解来解决定时任务，否则大部分情况可能都是使用 Quartz 来做定时任务。

项目创建完成后，需要添加开启定时任务的注解：

@SpringBootApplication
@EnableScheduling
public class QuartzApplication {
 
    public static void main(String[] args) {
        SpringApplication.run(QuartzApplication.class, args);
    }
 
}

Quartz 在使用过程中，有两个概念，一个是JobDetail（要做的事情），另一个是触发器（什么时候做），要定义 JobDetail，需要先定义 Job，Job 的定义有两种方式：

第一种方式，直接定义一个Bean：

首先将这个 Job 注册到 Spring 容器中。
这种定义方式有一个缺陷，就是无法传参。

@Component //(注册到spring容器中，不支持传参数)
public class MyFirstJob {
 
    public void sayHello(){
        System.out.println("first job :"+new Date());
    }
}

第二种定义方式，则是继承 QuartzJobBean 并实现默认的方法，支持传参：

public class MySecondJob extends QuartzJobBean {
 
    private String name;
 
    public void setName(String name) {
        this.name = name;
    }
 
    //任务启动时，executeInternal方法将会被执行。
    @Override
    protected void executeInternal(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        System.out.println("second job :"+name+":"+new Date());
    }
}

Job 有了之后，接下来创建类，配置 JobDetail 和 Trigger 触发器，JobDetail 的配置有两种方式：MethodInvokingJobDetailFactoryBean 和 JobDetailFactoryBean 。如下：

@Configuration
public class QuartzConfig {
 
    /**
     *MethodInvokingJobDetailFactoryBean配置目标Bean的类名和目标方法的名字，这种方式不支持传参
     */
    @Bean
    MethodInvokingJobDetailFactoryBean methodInvokingJobDetailFactoryBean(){ 
        MethodInvokingJobDetailFactoryBean bean = new MethodInvokingJobDetailFactoryBean();
        bean.setTargetBeanName("myFirstJob");
        bean.setTargetMethod("sayHello");
        return bean;
    }
 
    /**
     *JobDetailFactoryBean配置JobDetail，继承自QuartzJobBean ，这种方式支持传参，将参数封装在 JobDataMap中进行传递。
     */
    @Bean
    JobDetailFactoryBean jobDetailFactoryBean(){
        JobDetailFactoryBean bean = new JobDetailFactoryBean();
        JobDataMap map = new JobDataMap();
        map.put("name","javahello");//配置secondjob中的name
        bean.setJobDataMap(map);
        bean.setJobClass(MySecondJob.class);
        return bean;
    }
 
    /**
     * 配置触发器SimpleTrigger用法
     * 有点类似于前面说的 @Scheduled 的基本用法
     * @return
     */
    @Bean
    SimpleTriggerFactoryBean simpleTriggerFactoryBean(){
        SimpleTriggerFactoryBean bean = new SimpleTriggerFactoryBean();
        bean.setJobDetail(methodInvokingJobDetailFactoryBean().getObject());//绑定第一种方式methodInvokingJobDetailFactoryBean
        bean.setStartTime(new Date());
        bean.setRepeatInterval(2000); //重复的时间间隔
        bean.setRepeatCount(4); //重复次数
        return bean;
    }
    /**
     * 配置触发器CronTrigger用法
     * 有点类似于 @Scheduled 中 cron 表达式的用法
     * @return
     */
    @Bean
    CronTriggerFactoryBean cronTriggerFactoryBean(){
        CronTriggerFactoryBean bean = new CronTriggerFactoryBean();
        bean.setJobDetail(jobDetailFactoryBean().getObject());
        bean.setCronExpression("* * * * * ?");
        return bean;
    }
 
    /**
     * 启动定时任务（注入上面两个Trigger）
     * @return
     */
    @Bean
    SchedulerFactoryBean schedulerFactoryBean(){
        SchedulerFactoryBean bean = new SchedulerFactoryBean();
        bean.setTriggers(simpleTriggerFactoryBean().getObject(),cronTriggerFactoryBean().getObject());
        return bean;
    }
}

然后启动项目，控制台就可以看到定时任务的执行了。

代码已上传至：https://github.com/astronger/Spring-Boot-Quartz

一、@Scheduled
1. 通配符含义：
二、Quartz
1. 第一种方式，直接定义一个Bean：
2. 第二种定义方式，则是继承 QuartzJobBean 并实现默认的方法，支持传参：